Adding and editing github plumbing files#489
Conversation
andreacassioli
left a comment
andreacassioli
left a comment
There was a problem hiding this comment.
It looks pretty good to me! I left few comments but nothing major. I believe it is a good first step.
| | Template parameters | `PascalCase` | `template <class Graph, class WeightMap>` | | ||
| | Tag-dispatch types | `snake_case` + `S` suffix | `vecS`, `directedS` | | ||
| | Macros | `BOOST_GRAPH_` prefix, `SCREAMING_SNAKE_CASE` | `BOOST_GRAPH_DECLARE_EDGE_PROPERTY` | | ||
|
|
There was a problem hiding this comment.
is there also some convention about class members or methods? Like using m_ prefix?
There was a problem hiding this comment.
good call, thanks ! I added the prefixing :)
| - Track BGL's position in the Boost dependency DAG via [boostdep](https://github.com/boostorg/boostdep)'s hosted reports. The long-term goal is to reduce BGL's level over time: | ||
| - **[Module levels](https://pdimov.github.io/boostdep-report/master/module-levels.html#graph)** shows BGL's depth in the global DAG. A rising level means new transitive Boost dependencies have been pulled in. | ||
| - **[Per-library page](https://pdimov.github.io/boostdep-report/develop/graph.html)** shows BGL's direct deps and per-dep `#include` counts. | ||
|
|
There was a problem hiding this comment.
what about boost macros? looking around there is plenty of them in use.
There was a problem hiding this comment.
@andreacassioli thank you :) I just added an entire section providing guidance because it's a non trivial problem (Joaquin and Jeremy provided the table)
|
|
||
| When writing new code: | ||
|
|
||
| - **Prefer `std::`** when the supported C++ standard has an equivalent. Use `std::function`, `std::shared_ptr`, `std::tuple` over their Boost counterparts. |
There was a problem hiding this comment.
any exception? like some containers in std might be slower than boost (also some particular case might be in the pending folder...)
| | Template parameters | `PascalCase` | `template <class Graph, class WeightMap>` | | ||
| | Tag-dispatch types | `snake_case` + `S` suffix | `vecS`, `directedS` | | ||
| | Macros | `BOOST_GRAPH_` prefix, `SCREAMING_SNAKE_CASE` | `BOOST_GRAPH_DECLARE_EDGE_PROPERTY` | | ||
|
|
There was a problem hiding this comment.
Is there also some convention about class members or methods?
Also it is worth mentioning that there is .clang-format file that defines some of the style (I guess it is checked in CI?)
There was a problem hiding this comment.
thanks andrea ! I added the class members/methods convention !
I was not even aware of this clang-format, and it's actually not checked in CI, I mentioned it 😄 Maybe worth a future clang-format 120k loc PR ahaha. But likely not a priority.
Becheler
changed the title
2 participants
Summary
Adds the standard GitHub community files for Boost.Graph so that:
What's added
Repo-root community files
Those are required for the repo to pass the GitHub community profile check:
README.mdrefreshed for clarity and consistencyCONTRIBUTING.mdshow how to build, test, and submit changes, it shows up automatically in Github contributions flows (issue or PR filed)CODE_OF_CONDUCT.md: Contributor Covenant 2.1SECURITY.md: minimal. Reports via GitHub private vulnerability reporting that would need to be enabled..github/plumbingCODEOWNERS: review routing so @jeremy-murphy and @Becheler are automatically assigned as reviewers (make code ownership clear to contributors but we can adjust notifications if this becomes overwhelming)ISSUE_TEMPLATE/bug_report.md: focused on actionable stuff.ISSUE_TEMPLATE/feature_request.mdfocus on actionable stuff, redirects to Discussions for open-ended stuffISSUE_TEMPLATE/documentation.mdfor docs bugs, missing pages, broken examples.ISSUE_TEMPLATE/config.ymldisables blank issues and redirects design questions to GitHub Discussions.PULL_REQUEST_TEMPLATE.mdsome checks for triaging and testing.